home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / gen_bbs / aadd117b.zip / AUTOADD.DOC < prev    next >
Text File  |  1996-03-22  |  24KB  |  543 lines
  1.  
  2.  
  3.                              AutoAdd V1.17
  4.                 Copyright (C) 1995, 1996 David Blagburn
  5.                           All rights reserved
  6.  
  7.     What is AutoAdd?  Well, AutoAdd is a bridge between Allfix and
  8.   PCBoard.  Allfix allows automatic additions of new file areas but has
  9.   no way to let your BBS software (and consequently, your users) about
  10.   the new file area.  This is where AutoAdd comes in.  AutoAdd will:
  11.  
  12.      * Detect auto-added areas.
  13.      * Add the new areas to the BBS.
  14.      * Copy the FILES.BBS made by Allfix to a compatible format.
  15.      * Update Allfix (when registered) so that it will recognize the new
  16.        addition to your BBS, eliminating the need to run FCOMP.
  17.      * Update Allfix (when registered) with the description pulled from
  18.        FILEBONE.NA or FILEBONE.NO, eliminating the need to run FIXUTIL
  19.        Describe.
  20.      * Supports PCBoard 15.x, Renegade (4.17 or later), Maximus 3.0,
  21.        Telegard 3.0, T.A.G 2.7, Spitfire, LoraBBS 2.40, and ProBoard.
  22.  
  23.    *** NOTICE: REQUIRES ALLFIX 4.32 OR ALLFIX/2 1.XX (REGISTERED) ***
  24.    Auto-adding file areas is a registered feature of Allfix.  I have no
  25.    control over this.
  26.  
  27.   SETUP
  28.   -----
  29.     Put AUTOADD.EXE just about anywhere you want to, as long as you can
  30.   call it from a batch file.  
  31.  
  32.     AutoAdd requires certain switches and flags in Allfix to be setup up
  33.   in a compatible manner.  If you can not or are unwilling to make these
  34.   changes, then AutoAdd is not for you.
  35.  
  36.    Asetup switches that must be set:
  37.      In Asetup | Group Manager
  38.        All groups (that you expect to have areas added to) must have
  39.        Unique set to Yes.  If not, MAJOR problems!
  40.  
  41.    Because the setup is somewhat different for each BBS type, each
  42.  supported BBS type will be covered individually.
  43.  
  44.   USING AUTOADD
  45.   -------------
  46.     AutoAdd is designed to be run from a batch file, but can be run
  47.   anytime. The call is:
  48.  
  49.   AUTOADD <BBS type>
  50.  
  51.    where <BBS type> =
  52.        5 - ProBoard
  53.        8 - PCBoard
  54.        9 - Spitfire
  55.       13 - TAG
  56.       14 - Renegade ?.??
  57.       18 - LoraBBS 2.40
  58.       19 - Telegard 3.0
  59.       22 - Maximus 3.0
  60.     Note that this is the same parameter you would use in a call to FCOMP.
  61.  
  62.     Edit your AUTOADD.CFG to suit your system.  AUTOADD.CFG *must*
  63.   reside in the same directory as AUTOADD.EXE.  A sample configuration
  64.   file is included for each BBS type supported.
  65.  
  66.     The call to AutoAdd is: AUTOADD <BBS type>.
  67.  
  68.     AutoAdd will exit with an errorlevel of 1 if any file areas were
  69.   auto-added (if registered).  This may require editing for your
  70.   system.
  71.  
  72.   THE BATCH FILE
  73.   --------------
  74.     The way I call AutoAdd:
  75.     (snipped from my MAINT.001 batch file)
  76.  
  77.     REM CHECK FOR TIC'S. RUN ALLFIX IF ANY
  78.     IF NOT EXIST D:\PCB\FIDO\INBOUND *.TIC GOTO PASSAF
  79.     D:
  80.     CD \ALLFIX
  81.     ALLFIX File -NoCrc
  82.     REM RUN AUTOADD
  83.     D:\PCB\AUTOADD 8 <- your BBS type here
  84.     IF NOT ERRORLEVEL 1 GOTO PASSAF
  85.     REM What ever you want here
  86.     REM This line is for PCBoard
  87.     MAKEIDX D:\PCB\GEN\INDEX1.PTH D:\PCB\GEN\INDEX1.IDX
  88.  
  89.     :PASSAFF
  90.     ALLFIX Announce
  91.  
  92.  
  93.   AUTOADD.CFG
  94.   -----------
  95.     AUTOADD.CFG serves two purposes.  It is used in conjunction with your
  96.   key file (once you get you key file), and to define the necessary
  97.   information AutoAdd needs to work with your particular setup.  A great
  98.   deal of flexibility can be used here.
  99.  
  100.     The first two lines contain the name you used to register AutoAdd
  101.   (case sensitive) and your registration code, in that order.  The
  102.   remaining lines are either comments or configuration options.  Please
  103.   see the explanation below for your BBS type.  A sample configuration
  104.   file (individually archived) is provided for each supported BBS type.
  105.   There can be NO blank lines, nor should any line begin with a space.
  106.  
  107.    - Comment lines.
  108.          There can be an unlimited number of comment lines (well, as long
  109.        as you have disk space).  Each comment line must have a semicolon
  110.        (;) as the first character on the line.  They are also limited to
  111.        250 total characters per line (include the semicolon).
  112.  
  113.    - Configuration lines.
  114.          Each configuration line consists of a 4 letter key and one or
  115.        more fields.  Each field is separated by one or more spaces.
  116.        Configuration lines my appear in any order.  Unless specified,
  117.        only one occurrence (the last one) of each line will be honored.
  118.        Configuration lines are also limited to 250 total characters.
  119.  
  120.     Configuration lines give you a great deal of flexibility in
  121.   defining what AutoAdd is to do and how it is to do it.  Some are
  122.   common for all BBS types, while others define the defaults you would
  123.   like for such things as security levels, passwords, directory paths,
  124.   etc.
  125.  
  126.    - Configuration lines common to all BBS types.
  127.  
  128.      Key   Description
  129.      ---   -----------
  130.      AFIX  This line has only one field, the path to your Allfix
  131.            directory.
  132.  
  133.      LOGG  This line has only one field, the path where you would like
  134.            AUTOADD.LOG written.  If not present, AUTOADD.LOG will be
  135.            stored in the same directory as AUTOADD.EXE.  If a filename
  136.            is specified, that file will be used.
  137.  
  138.    - Configuration lines specific to BBS types.
  139.  
  140.      PCBOARD 15.x
  141.      ------------
  142.      Key   Description
  143.      ---   -----------
  144.      CNAM  This line has one field, the path and name you entered in
  145.            PCBSETUP->File Locations->System Files & Directories->Name/Loc
  146.            of Conference Data.  This is usually x:\PCB\MAIN\CNAMES, where
  147.            x is the drive letter.
  148.  
  149.      DIRP  This line has one field, the path you would like to store the
  150.            new DIRx style file in.  When an area is auto-added, Allfix
  151.            creates a FILES.BBS file in the same path the files are
  152.            stored in.  AutoAdd will always make a new file from the
  153.            FILES.BBS, naming it the same as the AreaTag for the new file
  154.            area and inserting the standard PCB DIRx header lines.  This
  155.            line will allow you to specify another directory to store the
  156.            DIRx file created by AutoAdd.  If not used, the new file will
  157.            be created in the same directory as the FILES.BBS file.
  158.  
  159.      CONF  This is the line that gives AutoAdd it's power.  There can be
  160.            up to 256 of these line.  The CONF line contains several
  161.            fields.  Each field must be present and in the correct order.
  162.  
  163.            - field 1: PCBoard conference (0 - 65567)
  164.                       This is the PCBoard conference you would like to
  165.                       be updated for an Allfix defined group.
  166.  
  167.            - field 2: group(s) (0 - 255) (79 characters max)
  168.                       AutoAdd allows you to assign a conference to each
  169.                       file echo group defined in Allfix.  This gives you
  170.                       the flexibility to specify which FILEBONE.NA style
  171.                       file goes with each file echo group and which
  172.                       PCBoard conference files (DIR.LST and DLPATH.LST)
  173.                       to update.
  174.  
  175.                       More than one group can be specified by separating each
  176.                       group by a semicolon (;).  Ex. 3;5;22
  177.  
  178.                       A range can be specified by separating the first and
  179.                       last group in the range by a dash (-). Ex. 23-255
  180.                       A combination can also be used. Ex 0;3-5;9-15
  181.  
  182.            - field 3: Path and name of the FILEBONE.NA style file to use
  183.                       for the group(s) defined in field 2.  The file
  184.                       defined here will be searched for the AreaTag of
  185.                       the newly added area.  The description for the
  186.                       auto-added area as defined in the FILEBONE.NA
  187.                       style file is then used to update file area
  188.                       descriptions in PCBoard and Allfix.
  189.  
  190.            - field 4: Path and name of the index.pth file to use.  This
  191.                       field allows you to define whether to update
  192.                       DLPATH.LST or a text file for use with MAKEIDX.
  193.                       Enter "NONE" (without quotes) not update anything.
  194.                       Leave blank to use the DLPATH.LST for the
  195.                       specified conference.
  196.  
  197.      RENEGADE (versions later than 4.16)
  198.      -----------------------------------
  199.      Key   Description
  200.      ---   -----------
  201.      DATA  This line has one field, the path to where FBASES.DAT and
  202.            EXTENDED.DAT are stored.  This is usually x:\RENEGADE\DATA,
  203.            where x is the drive letter.
  204.  
  205.      FBON  This line has one field, the path and name of a FILEBONE.NA
  206.            style file.  There can be more than one FBON line.  Each will
  207.            be searched, in order, for the AreaTag of the auto-added file
  208.            area.  The description for the auto-added area as defined in
  209.            the FILEBONE.NA style file is then used to update file area
  210.            descriptions in Renegade and Allfix.
  211.  
  212.      DEFN  This line has multiple fields and contains the defaults for
  213.            the newly added file area.  This line is highly formatted. Use
  214.            care when you edit it.
  215.  
  216.            - field 1: The path to use as the upload directory.  Enter
  217.                       "SAME" (without quotes) if you wish it to be the
  218.                       same as the download path.  40 characters max
  219.                       (including trailing "\".  This is a Renegade
  220.                       limit).
  221.  
  222.            - field 2: Access, max files, archiver, and flags.  Each
  223.                       subfield is separated by a comma.  All subfields
  224.                       must be present.  If a subfield is not used, the
  225.                       comma must still be used as a place holder.
  226.  
  227.             - subfield 1: Password.  12 characters max.
  228.  
  229.             - subfield 2: Access (ACS).  20 characters max.
  230.  
  231.             - subfield 3: Upload access (ULACS).  20 characters max.
  232.  
  233.             - subfield 4: Download access (DLACS).  20 characters max.
  234.  
  235.             - subfield 5: Maximum files allowed in this area. 1-65635.
  236.  
  237.             - subfield 6: Archiver.  0 thru number of archivers defined in
  238.                           Renegade.  Warning: validity of this field is
  239.                           not checked.  8 is the highest value Renegade
  240.                           allows.  0 = None defined.
  241.  
  242.             - subfield 7: Archive Comment.  1 - 3 as setup in Renegade.
  243.  
  244.             - subfield 8: Credits required for download for each file.
  245.                           This will be used in the new *.DIR file.
  246.  
  247.             - subfield 9: Flags: C - CD-ROM
  248.                                  G - Gif Specs
  249.                                  D - Date Uploaded
  250.                                  S - Show Uploader Name
  251.                                  I - *.DIR in DLPATH
  252.                                  U - Unhidden
  253.                                  N - No Ratio
  254.                           The I flag is honored by AutoAdd.
  255.  
  256.      MAXIMUS 3.X
  257.      -----------
  258.      Key   Description
  259.      ---   -----------
  260.      DATA  This line has one field, the path to MAX.PRM.  This is
  261.            usually x:\MAX\, where x is the drive letter.
  262.  
  263.      FBON  This line has one field, the path and name of a FILEBONE.NA
  264.            style file.  There can be more than on FBON line.  Each file
  265.            will be searched, in order, for the AreaTag of the auto-added
  266.            file area.  The description for the auto-added area as
  267.            defined in the FILEBONE.NA style file is then used to update
  268.            file area descriptions in Maximus and Allfix.
  269.  
  270.      DEFN  This line has two fields, the default upload path and access
  271.            name.
  272.  
  273.            - field 1: The path to use as the upload directory.  No check
  274.                       is made for the validity of the path.
  275.  
  276.            - field 2: Access name (level) for this file area.  Enter the
  277.                       <name> for the access level as defined in
  278.                       ACCESS.CTL (Sysop, Demoted, etc).
  279.  
  280.      TELEGARD 3.0
  281.      ------------
  282.      Key   Description
  283.      ---   -----------
  284.      DATA  This line has one field, the path to CONFIG.TG.  This is
  285.            usually x:\TELEGARD\, where x is the drive letter.
  286.  
  287.      FBON  This line has one field, the path and name of a FILEBONE.NA
  288.            style file.  There can be more than on FBON line.  Each file
  289.            will be searched, in order, for the AreaTag of the auto-added
  290.            file area.  The description for the auto-added area as
  291.            defined in the FILEBONE.NA style file is then used to update
  292.            file area descriptions in Telegard and Allfix.
  293.  
  294.      DEFN  This line has one field, but many subfields.  It contains
  295.            the defaults to use when defining the new file area in
  296.            Telegard.
  297.  
  298.           - field 1: Archiver, accesses, flags.  Each subfield is
  299.             separated by a comma.  Even if a subfield is not used, the
  300.             comma must be present as a place holder.
  301.  
  302.             - subfield 1: Archiver (ZIP, ARJ, ARC, ZOO, etc).
  303.  
  304.             - subfield 2: Sysop access.
  305.  
  306.             - subfield 3: Access required to view the file list.
  307.  
  308.             - subfield 4: Access required to see Uploader name.
  309.  
  310.             - subfield 5: Access required to upload files.
  311.  
  312.             - subfield 6: Access required to download files.
  313.  
  314.             - subfield 7: Scan type - 0 - default on
  315.                                       1 - default off
  316.                                       2 - always.
  317.  
  318.             - subfield 8: Flags - N - Noratio
  319.                                   V - Visible
  320.                                   G - GifSpecs
  321.  
  322.  
  323.      SPITFIRE
  324.      --------
  325.      Key   Description
  326.      ---   -----------
  327.      DATA  This line has one field, the path to SFFAREA.DAT.  This is
  328.            usually x:\SPITFIRE\, where x is the drive letter.
  329.  
  330.      FBON  This line has one field, the path and name of a FILEBONE.NA
  331.            style file.  There can be more than on FBON line.  Each file
  332.            will be searched, in order, for the AreaTag of the auto-added
  333.            file area.  The description for the auto-added area as
  334.            defined in the FILEBONE.NA style file is then used to update
  335.            file area descriptions in Spitfire and Allfix.
  336.  
  337.      DEFN  This has three fields.  The first two fields must be present,
  338.            while the last field my be left blank to use the defaults.
  339.  
  340.           - field 1: Upload path.  If you would like the upload path and
  341.                      download path to be the same, enter "SAME" (without
  342.                      the quotes).  Maximum of 60 characters, including
  343.                      the trailing "\".
  344.  
  345.           - field 2: File area access level. 0 - 255.
  346.  
  347.           - field 3: File area flags - E - User must have security level
  348.                                            equal to file area security
  349.                                            to upload or download.
  350.                                            Default is Equal to or
  351.                                            greater than.
  352.                                        S - Allow users with less
  353.                                            security to view files list.
  354.                                            Default is not to allow
  355.                                            viewing of the files list.
  356.  
  357.      PROBOARD
  358.      --------
  359.      Key   Description
  360.      ---   -----------
  361.      DATA  This line has one field, the path to FILECFG.PRO.  This is
  362.            usually x:\PB\, where x is the drive letter.
  363.  
  364.      FBON  This line has one field, the path and name of a FILEBONE.NA
  365.            style file.  There can be more than on FBON line.  Each file
  366.            will be searched, in order, for the AreaTag of the auto-added
  367.            file area.  The description for the auto-added area as
  368.            defined in the FILEBONE.NA style file is then used to update
  369.            file area descriptions in ProBoard and Allfix.
  370.  
  371.      DEFN  This line has several fields, each seperated by a comma.  You
  372.            may define the defaults to use for the new file area here.
  373.  
  374.          - field 1: File area security level
  375.  
  376.          - field 2: File area access flags (A thru Z, 1 thru 6). Order
  377.                     does not matter nor does case.  You can make neat
  378.                     words here, like AutoAdd115.  In this case flags
  379.                     ADOTU15 would be set.
  380.          - field 3: Maximum files allowed to DL.
  381.  
  382.          - field 4: Maximum kilobytes allowed to DL.
  383.  
  384.          - field 5: Do NOT show in TOPS.PB.  T, true, True, TRUE all mean
  385.                     "No. Do not show in TOPS.PB".  Only the first letter
  386.                     is checked.
  387.  
  388.          - field 6: Free files. True or False (T or F). Same method as
  389.                     field 5.  Only the first letter is checked.
  390.  
  391.          - field 7: Minimum age. 0 - 1000.  Well, actually the range is
  392.                     much greater, but I think the average life span is
  393.                     well covered.
  394.  
  395.          - field 8: Date format. 0 - MM/DD/YY
  396.                                  1 - DD/MM/YY
  397.                                  2 - YY/MM/DD
  398.  
  399.          - field 9: Groups this area belongs to.  "*" = All groups.
  400.                     Otherwise, up to 4 groups may be listed, seperated by
  401.                     a comma.
  402.  
  403.      TAG 2.7
  404.      -------
  405.      Key   Description
  406.      ---   -----------
  407.      DATA  This line has one field, the path to FBOARDS.DAT.  This is
  408.            usually x:\TAG\DFILES\, where x is the drive letter.
  409.  
  410.      FBON  This line has one field, the path and name of a FILEBONE.NA
  411.            style file.  There can be more than on FBON line.  Each file
  412.            will be searched, in order, for the AreaTag of the auto-added
  413.            file area.  The description for the auto-added area as
  414.            defined in the FILEBONE.NA style file is then used to update
  415.            file area descriptions in TAG and Allfix.
  416.  
  417.      DEFN  This line has several fields, each seperated by a comma.  You
  418.            may define the defaults to use for the new file area here.
  419.  
  420.           - field 1: Password. 15 characters max.
  421.  
  422.           - field 2: Access. 0 - 255.
  423.  
  424.           - field 3: Access level to see Uploader name. 0-255.
  425.  
  426.           - field 4: No Ratio flag. "True" or "T" for "Yes, no ratio.",
  427.                      or  "False" or "F" for "No, ratio active."
  428.  
  429.           - field 5: Group this file area belongs to. 0-127.
  430.  
  431.           - field 6: AR flag. @..Z. Only one flag allowed.
  432.  
  433.           - field 7: Use "FILES" as the filename for the files list.
  434.                      "True" or "T", "False" of "F".  Defaults to "False.
  435.                      Do not use FILES as the filename for the files
  436.                      list."
  437.  
  438.            All fields must be seperated by a comma.  All fields must be
  439.            present.  This means that even if a field is not used, a comma
  440.            must be used as a place holder.
  441.  
  442.      LORABBS 2.40
  443.      ------------
  444.      Key   Description
  445.      ---   -----------
  446.      DATA  This line has one field, the path to SYSFILE.DAT.  This is
  447.            usually x:\LORA\, where x is the drive letter.
  448.  
  449.      FBON  This line has one field, the path and name of a FILEBONE.NA
  450.            style file.  There can be more than on FBON line.  Each file
  451.            will be searched, in order, for the AreaTag of the auto-added
  452.            file area.  The description for the auto-added area as
  453.            defined in the FILEBONE.NA style file is then used to update
  454.            file area descriptions in LoraBBS and Allfix.
  455.  
  456.      DEFN  This line has several fields, each seperated by a comma.  You
  457.            may define the defaults to use for the new file area here.
  458.  
  459.           - field 1: Minimum area number.  This is the lowest area
  460.                      number AutoAdd will use when adding new file areas.
  461.                      The new area number will always be the highest in
  462.                      the file area database.
  463.  
  464.           - field 2: Upload path.  This is a required field.
  465.  
  466.           - field 3: Free files area, True (T) or False (F).
  467.  
  468.           - field 4: Exclude this area from global searchs, True or
  469.                      False.
  470.  
  471.           - field 5: Minimum level required for this area. 1 - Twit,
  472.                                                            2 - Disgrace,
  473.                                                            3 - Limited,
  474.                                                            ...,
  475.                                                           13 - Hidden
  476.  
  477.           - field 6: Access flags. 0-9 and A-V.  Order does not matter.
  478.  
  479.           - field 7: File area access level. 1 - Twit.....
  480.  
  481.           - field 8: File area flags. 0-9 and A-V.
  482.  
  483.           - field 9: Download access. 1 - Twit.....
  484.  
  485.           - field 10: Download flags. 0-9 and A-V.
  486.  
  487.           - field 11: Upload access. 1 - Twit....
  488.  
  489.           - field 12: Upload flags. 0-9 and A-V.
  490.  
  491.           All fields must be seperated by a comma.  All fields must be
  492.         present.  This means that even if a field is not used, a comma
  493.         must be used as a place holder.  Fields 5 - 12 are optional.
  494.         They will all default to Twit privilages and no flags.  No
  495.         fields may be skipped.  If not used or you desire the default,
  496.         you must use a comma as a place holder for fields preceding the
  497.         field you do use.
  498.  
  499.  
  500.   REGISTRATION
  501.   ------------
  502.     Registration is $5.00 (US).  Registration will enable the updating of
  503.   Allfix.  See AUTOADD.REG for further information.
  504.  
  505.   EVALUATION KEY
  506.   --------------
  507.     A 30 day evaluation key can be obtained by calling the support BBS
  508.   (The Spy's Nest, see below), logging on with the name and password of
  509.   AUTOADD.  After logging on, you should be in Conference 4.  Type EVAL
  510.   and follow the on-screen instructions.
  511.  
  512.   CONTACTING THE AUTHOR
  513.   ---------------------
  514.     I can be reached at:
  515.          The Spy's Nest 1-904-458-0982/1-904-457-9111 (V.34/VFC)
  516.          FIDO 1:3612/386 (or 1:3612/386.1)
  517.     I also hang out in ALLFIX_HELP and supported BBS type support echos.
  518.  
  519.   WARRANTY & DISCLAIMER
  520.   ---------------------
  521.     There are no warranties, express or implied, for unregistered copies
  522.   of AutoAdd.  The author will NOT be held liable for any direct,
  523.   indirect, incidental, or consequential damage resulting from the use
  524.   of this program.  Your use of this program constitutes your AGREEMENT
  525.   to this disclaimer and your release of the author from any form of
  526.   liability.
  527.  
  528.     Registered copies of AutoAdd are warranted to perform as described
  529.   in this documentation.  In the event AutoAdd does not perform as
  530.   described, then the author will elect to either rectify the problem or
  531.   refund the amount of the registration paid, provided notification is
  532.   received within 30 days of registration.
  533.  
  534.     All brand and product names are Copyrighted (C) material, Trademarks
  535.   (tm) or Registered (R) Trademarks of their respective holders:
  536.   Allfix                        Harald Harmes
  537.   PCBoard                       Clark Developement Co.
  538.   Renegade                      Cott Lang
  539.   Maximus                       Lanius Corporation
  540.   Telegard                      Tim Strike
  541.   SpitFire                      Buffalo Creek Software
  542.   ProBoard                      Philippe Leybaert
  543.